<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class CPSCommonBase</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class CPSCommonBase</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">CPSCommonBase provides methods that are common to both CComponent and CWidget.</p>
<p class="description"><p>Since these two classes do not share a common base far enough up the subclasses tree,  it is more modular to have this class provide the common methods necessary between  our (@link CPSWidget) and (@link CPSComponent).</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Jerry Ablan &lt;<a href="mailto:jablan@pogostick.com">jablan@pogostick.com</a>&gt;</li>
				<li><span class="field">version:</span> SVN: $Id: CPSCommonBase.php 243 2009-06-13 01:34:31Z jerryablan@gmail.com $</li>
				<li><span class="field">since:</span> 1.0.0</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_pogostick---base---CPSCommonBase.php.html">/pogostick/base/CPSCommonBase.php</a> (line <span class="field">26</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>


	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<img src="../../media/images/Constant.png" alt=" " />
					<a href="#BEHAVIOR_META_METHODS" title="details" class="const-name">BEHAVIOR_META_METHODS</a> = 					<span class="var-type"> '_classMethods'</span>

				</div>
								<div class="const-title">
					<img src="../../media/images/Constant.png" alt=" " />
					<a href="#BEHAVIOR_META_OBJECT" title="details" class="const-name">BEHAVIOR_META_OBJECT</a> = 					<span class="var-type"> '_object'</span>

				</div>
								<div class="const-title">
					<img src="../../media/images/Constant.png" alt=" " />
					<a href="#BEHAVIOR_META_VALID" title="details" class="const-name">BEHAVIOR_META_VALID</a> = 					<span class="var-type"> '_validOptions'</span>

				</div>
								<div class="const-title">
					<img src="../../media/images/Constant.png" alt=" " />
					<a href="#BEHAVIOR_META_VARS" title="details" class="const-name">BEHAVIOR_META_VARS</a> = 					<span class="var-type"> '_classVars'</span>

				</div>
							</div>
		</div>
	</div>


	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
									<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
												<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#createInternalName" title="details" class="method-name">createInternalName</a>
											(<span class="var-type"><a href="../../psYiiExtensions/Base/CPSWidget.html">CPSWidget</a>|<a href="../../psYiiExtensions/Base/CPSComponent.html">CPSComponent</a></span>&nbsp;<span class="var-name">&$oComponent</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">mixed</span>
										<a href="#getBehaviorProperty" title="details" class="method-name">&amp;getBehaviorProperty</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$oComponent</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$sName</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">null|(@link</span>
										<a href="#hasBehaviorMethod" title="details" class="method-name">&amp;hasBehaviorMethod</a>
											(<span class="var-type">object Component</span>&nbsp;<span class="var-name">$oComponent</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$sMethodName</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">boolean</span>
										<a href="#hasBehaviorProperty" title="details" class="method-name">&amp;hasBehaviorProperty</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$oComponent</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$sName</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">void</span>
										<a href="#setBehaviorProperty" title="details" class="method-name">setBehaviorProperty</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$oComponent</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$sName</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$oValue</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">null</span>
										<a href="#writeLog" title="details" class="method-name">writeLog</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$sMessage</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$sLevel</span> = <span class="var-default">'info'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$sCategory</span> = <span class="var-default">'application'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$sExceptionMessage</span> = <span class="var-default">null</span>])
									</div>
								
																																																				</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodcreateInternalName" id="createInternalName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method createInternalName</span> (line <span class="line-number">46</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates the internal name of a component/widget. Use (@link setInternalName) to change.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			createInternalName
		</span>
					(<span class="var-type"><a href="../../psYiiExtensions/Base/CPSWidget.html">CPSWidget</a>|<a href="../../psYiiExtensions/Base/CPSComponent.html">CPSComponent</a></span>&nbsp;<span class="var-name">&$oComponent</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../../psYiiExtensions/Base/CPSWidget.html">CPSWidget</a>|<a href="../../psYiiExtensions/Base/CPSComponent.html">CPSComponent</a></span>
				<span class="var-name">&$oComponent</span><span class="var-description">: The</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetBehaviorProperty" id="getBehaviorProperty"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method getBehaviorProperty</span> (line <span class="line-number">135</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a property from an attached behavior or throws an exception which can be caught</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../psYiiExtensions/Base/CPSCommonBase.html#methodsetBehaviorProperty">CPSCommonBase::setBehaviorProperty()</a></li>
				<li><span class="field">see:</span> <a href="../../psYiiExtensions/Base/CPSCommonBase.html#methodhasBehaviorProperty">CPSCommonBase::hasBehaviorProperty()</a></li>
				<li><span class="field">throws:</span> CException</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">mixed</span>
		<span class="method-name">
			&amp;getBehaviorProperty
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$oComponent</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$sName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$oComponent</span><span class="var-description">: The component or widget to work with</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$sName</span>			</li>
				</ul>
		
			
	</div>
<a name="methodhasBehaviorMethod" id="hasBehaviorMethod"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method hasBehaviorMethod</span> (line <span class="line-number">70</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Test to see if a behavior has a particular method available</p>
	<ul class="tags">
				<li><span class="field">return:</span> CPSOptionManager)</li>
				<li><span class="field">see:</span> <a href="../../psYiiExtensions/Base/CPSCommonBase.html#methodhasBehaviorProperty">CPSCommonBase::hasBehaviorProperty()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">null|(@link</span>
		<span class="method-name">
			&amp;hasBehaviorMethod
		</span>
					(<span class="var-type">object Component</span>&nbsp;<span class="var-name">$oComponent</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$sMethodName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$sMethodName</span><span class="var-description">: Name to look for</span>			</li>
					<li>
				<span class="var-type">object Component</span>
				<span class="var-name">$oComponent</span><span class="var-description">: or widget to work with</span>			</li>
				</ul>
		
			
	</div>
<a name="methodhasBehaviorProperty" id="hasBehaviorProperty"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method hasBehaviorProperty</span> (line <span class="line-number">98</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determines whether a behavior property is defined.</p>
<p class="description"><p>A behavior property is defined if there is a getter or setter method  defined in the behavior class. Note, property names are case-insensitive.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> whether the property is defined</li>
				<li><span class="field">see:</span> <a href="../../psYiiExtensions/Base/CPSCommonBase.html#methodhasBehaviorMethod">CPSCommonBase::hasBehaviorMethod()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">boolean</span>
		<span class="method-name">
			&amp;hasBehaviorProperty
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$oComponent</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$sName</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$oComponent</span><span class="var-description">: the property name</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$sName</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetBehaviorProperty" id="setBehaviorProperty"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method setBehaviorProperty</span> (line <span class="line-number">156</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets a property in an attached behavior if it exists or throws a catchable exception</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../../psYiiExtensions/Base/CPSCommonBase.html#methodgetBehaviorProperty">CPSCommonBase::getBehaviorProperty()</a></li>
				<li><span class="field">see:</span> <a href="../../psYiiExtensions/Base/CPSCommonBase.html#methodhasBehaviorProperty">CPSCommonBase::hasBehaviorProperty()</a></li>
				<li><span class="field">throws:</span> CException</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">void</span>
		<span class="method-name">
			setBehaviorProperty
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$oComponent</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$sName</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$oValue</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$oComponent</span><span class="var-description">: The component or widget to work with</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$sName</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$oValue</span>			</li>
				</ul>
		
			
	</div>
<a name="methodwriteLog" id="writeLog"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method writeLog</span> (line <span class="line-number">179</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Outputs to the log and optionally throws an exception</p>
	<ul class="tags">
				<li><span class="field">throws:</span> CException</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
	    static
		<span class="method-result">null</span>
		<span class="method-name">
			writeLog
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$sMessage</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$sLevel</span> = <span class="var-default">'info'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$sCategory</span> = <span class="var-default">'application'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$sExceptionMessage</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$sMessage</span><span class="var-description">: The message to log. Supports the '{class}' parameter substitution.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$sLevel</span><span class="var-description">: The level of the logged message. Defaults to 'info'</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$sExceptionMessage</span><span class="var-description">: If supplied, will throw an exception</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$sCategory</span><span class="var-description">: The category of the logged message. Defaults to 'application'</span>			</li>
				</ul>
		
			
	</div>

						
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="constBEHAVIOR_META_METHODS" id="BEHAVIOR_META_METHODS"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">BEHAVIOR_META_METHODS</span>
			 = <span class="const-default"> '_classMethods'</span>
			(line <span class="line-number">32</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
<a name="constBEHAVIOR_META_OBJECT" id="BEHAVIOR_META_OBJECT"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">BEHAVIOR_META_OBJECT</span>
			 = <span class="const-default"> '_object'</span>
			(line <span class="line-number">33</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
<a name="constBEHAVIOR_META_VALID" id="BEHAVIOR_META_VALID"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">BEHAVIOR_META_VALID</span>
			 = <span class="const-default"> '_validOptions'</span>
			(line <span class="line-number">34</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
<a name="constBEHAVIOR_META_VARS" id="BEHAVIOR_META_VARS"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">BEHAVIOR_META_VARS</span>
			 = <span class="const-default"> '_classVars'</span>
			(line <span class="line-number">35</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
						
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Mon, 15 Jun 2009 22:58:15 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
	</p>
	</div></body>
</html>